home *** CD-ROM | disk | FTP | other *** search
/ United Public Domain Gold 2 / United Public Domain Gold 2.iso / utilities / pu737.dms / pu737.adf / xmash_v1.0 / Xmash.DOC < prev    next >
Text File  |  1995-02-13  |  11KB  |  327 lines
  1.  
  2.                     XMASH - The Ultimate Disk Masher V1.0
  3.  
  4.  
  5.                 XMash is (C) HYDRA of LSD, Perspex & Radiance
  6.  
  7. >>>>>>>> SYSOPS PLEASE READ THE NOTE AT THE BOTTOM OF THE FILE.. <<<<<<<<<<<<<
  8.  
  9. Right then,  so you're wondering what the bloody hell Xmash is by now aren't
  10. you ?  Well I supose I better tell you then!
  11.  
  12. It's a small program that lets you read data from a floppy disk and save
  13. it in compressed files and then at a later time you can de-compress it back
  14. to another disks, simple really!
  15.  
  16. Many other program have attempted to do this but there's always been
  17. something wrong with them, DMS for example is alright, but the files it
  18. creates are large and sometimes it wont compress disks and doesnt tell
  19. you that it hasnt compressed it.
  20. Another thing about DMS is it's error handling!  If you get a CRC or
  21. data error it'll stop dead in it's tracks, XMASH on the other hand will
  22. contine searching the file until it finds more data that it recognises.
  23.  
  24. XMASH uses the XPK Compression libraries for MAXIUM compatability and
  25. compression.  This leaves XMASH free to concentrate on the user interface
  26. and error handling instead of getting caught up in complicated comression
  27. algorithms,  it leaves this the xpkxxxx libraries.
  28.  
  29.  
  30.  
  31. How to install XMASH
  32.  
  33. To install XMash just make sure you have xpkmaster.library in libs:
  34. and some compressor libraries in Libs:Compressors (preferably
  35. XPKNUKE,FAST,SHRI and HFMN)  XMash defaults to using XPKSHRI.library as
  36. this provides the best compresion ratio (but is a little slow!)
  37.  
  38. If use NUKE compressor you wont even notice XMash compressing as it's
  39. SOOOO fast (but files are larger than SHRI)
  40.  
  41. Next you need to copy XMASH somewhere in your path,  I prefer SYS:Archivers
  42. but C: will do for most.
  43.  
  44.  
  45. How do I use XMASH
  46.  
  47.   Xmash has a wealth of options avaliable, these are as follows
  48.  
  49.   READ=R/K,WRITE=W/K,FROM=TO/K,LOW=L/N,HIGH=H/N,TEXT=BANNER/K
  50.   TEST=T/K,APPEND/S,ADDTEXT/K,DESCRIBE=ADDDESC/K
  51.   DESCRIPTIONTEXT=DT/K,COMPRESSOR=MODE/K,TRACKINC/K/N,EXTRACT/K
  52.   QUIET/S,FIRST/S,DEVICE/K,TRACKS/K
  53.  
  54.   Here's each parameter in more detail.
  55.  
  56.   key to symbols (dont include *ANY* symbols on the command line!)
  57.  
  58.    |      alternatives specify only one. (EG fred|sid|barney)
  59.    []     optional parameter (see defaults.) [help|nohelp]
  60.    <>     type of object (E.G.  <Filename>)
  61.    <nn>   number
  62.  
  63.   Everything else is as it is written.
  64.  
  65.   Note:
  66.     Even tho I showed you a 2.04 style
  67.     usage template you cant use the '=' (equals) sign is the parameters (you
  68.     must seperate parameters by the ' ' space character)
  69.  
  70.  
  71. Compressing A Disk To A File
  72.  
  73.   Usage:
  74.  
  75.     XMASH Read|r <Filename>[.xms] [From <dfx:>] [Low|L <nn>] [high|h <nn>]
  76.         [text|banner <textfilename>] [descriptiontext|dt <descriptionfilename>]
  77.         [compressor|Mode <compressor library>[.<nnn>]] [append] [trackinc <nn>]
  78.         [Device devicename] [Quiet]
  79.  
  80.   Simple Example:
  81.  
  82.     XMASH Read UL:NewFile.XMS From DF2: Low 0 High 39 Text BBS:BBSaddvert
  83.           DT FileDescs:NewFile.DIZ Mode FAST.100 Trackinc 10
  84.  
  85.   Parameters:
  86.  
  87.     <Filename>[.xms]
  88.  
  89.           The name of the compressed file to save data in (you may
  90.           add the .XMS if you want, but if you dont XMASH will add it
  91.           to the end of the filename.
  92.           E.G. dh0:archived_stuff/cooldemo.xms
  93.  
  94.     [From <dfx:>]
  95.  
  96.           Uses specified drive to read disk from. Defaults to DF0:
  97.           (replace x with a unit number)
  98.           E.G. From DF1:
  99.  
  100.     [Low|L <nn>]
  101.  
  102.           Start Reading the disk from CYLINDER <nn>
  103.           where <nn> is from 00 to 79
  104.           E.G. Low 20
  105.  
  106.     [High|H <nn>]
  107.  
  108.           Stop Reading the disk at CYLINDER <nn>
  109.           where <nn> is from 00 to 79
  110.           E.G. High 50
  111.  
  112.     [Text|Banner <textfilename>
  113.  
  114.           Add a text file to the compressed file that will
  115.           be displayed when you unpack it.
  116.           (Note: the text file MUST be smaller than half your availiable
  117.           memory, so you *CAN* do really long text files if you want to!)
  118.           (note2: currently I've not made a way of removing text files
  119.           from an archive, but if you programmers out there want to make
  120.           a program that does then see the FileFormat.doc file included
  121.           with this program..)
  122.  
  123.           E.G. Text bbs:bbsadd.ansi
  124.  
  125.     [DescriptionText|DT <descriptionfilename>]
  126.  
  127.           Add a file description to the file,  this is mainly used in BBS
  128.           systems.  Example usage of a file description is when you
  129.           upload a file to the BBS youwont have to sit there typing
  130.           in a file description, you can write the description Off-Line!
  131.           (see, Xmash has saved you money already!)
  132.           E.G. DT FileDescripts:Demo.desc
  133.  
  134.     [Compressor|Mode <Compressor Library>[.<nnn>]]
  135.  
  136.           This is the clever bit that lets you specify what xpk compressor
  137.           library to use.  The optional number specifies the compression
  138.           level to use (.100 = best, .000 = worst)
  139.           Only specify the 4 digits of the compressor library, so if you
  140.           wanted to use xpkNUKE.library you would use Compressor NUKE
  141.           or Mode NUKE.100
  142.           (compressors that encrypt data are NOT supported (yet!))
  143.  
  144.     [Append]
  145.  
  146.           This lets you add more tracks to an already compressed file
  147.           Typical usage could be to append a patch onto an existing file
  148.           (note: if you want to you can use a different compressor library
  149.           to the one that's used in the origonal file, so if you want
  150.           you could compress a disk with each track being compressed
  151.           with a different compressor.)
  152.           (note2: you can add more textfiles like this!!)
  153.  
  154.     [Trackinc <nn>]
  155.  
  156.           This paramter has got to be the single most important parameter
  157.           of this program.  It tells Xmash how many tracks to read into
  158.           memory before it compresses them,  the more tracks the better
  159.           they get compressed, but the it takes longer to compress and
  160.           uses more memory ((5632 * Trackinc) * 2 + a margin)
  161.           This defaults to 10 tracks. (5 cylinders)
  162.           (note: this is Tracks not Cylinders. There are 160 tracks to
  163.           a standard 880K Amiga disk, Cylinders * 2 Surfaces!)
  164.           E.G.  Trackinc 20
  165.  
  166.     [Tracks <tracklist>]
  167.  
  168.           This option tells XMASH to pack a list of tracks specified by
  169.           tracklist.
  170.  
  171.           The format of the tracklist is thus:  tracknumber[-tracknumber],...
  172.  
  173.           E.G.
  174.  
  175.           Tracks 5,32-35,70,72-79
  176.  
  177.           The above example would cause XMASH to pack track 5, followed by
  178.           tracks 32 to 35 then track 70 then tracks 72-79
  179.  
  180.           This feature is great when you want to make fix's and trainer files!
  181.  
  182.           (Thanks go to MuB/LSD for this cool idea!)
  183.  
  184.     [Device devicename]
  185.  
  186.           This lets you use any device that supports the standard
  187.           trackdisk.device commands.  This is usefull when you use things like
  188.           TEQDISK which lets you read and write to files on your hard disk
  189.           as if they werestandard floppy disks.  Note:  at present XMASH
  190.           wont get the ACTUAL devicename (E.G. trackdisk.device) from the
  191.           actual mounted device (E.G. DF0:) you must specify the mounted
  192.           device's name using the FROM/TO parameter.
  193.  
  194.           Also be aware that the device name IS case sensitive (as as any
  195.           device/library name on the Amiga!)
  196.  
  197.           E.G.  Xmash Read Ram:TEST from TE0: device TEQDISK.device
  198.  
  199.           (Again thanks to MuB/LSD for this idea!)
  200.  
  201. How to write a compressed file back to a disk
  202.  
  203.   Usage:
  204.  
  205.     XMASH Write|W <Filename>[.xms] [To <dfx:>] [Low|L <nn>] [high|h <nn>]
  206.           [Device devicename] [Quiet]
  207.   Simple Example:
  208.  
  209.     XMASH Write DL:NewFile.XMS To DF1:
  210.  
  211.   Parameters:
  212.  
  213.     [To <dfx:>]
  214.  
  215.           Uncompresses the compressed file to specified drive
  216.           E.G.  To DF2:
  217.  
  218.     All other parameters as per Compressing a disk.
  219.  
  220.   Notes:
  221.  
  222.     Low and High will only write blocks of tracks (specified by
  223.     trackinc when you compress the disk.)  E.G.  say you packed the disk
  224.     with trackinc set to 20 (thats 10 cylinders per crunched block of data)
  225.     and you wanted to just unpack Cylinder 2 then you would use the command
  226.     XMASH write <file> Low 2 High 2
  227.     If you did this you would notice that Cylinders 0-9 get written to
  228.     the disk,  this is because they are all in the same block and this
  229.     version of XMASH wont split up blocks of crunched data into single
  230.     cylinders (although if people want it to then I may implement it)
  231.  
  232. How to add a text file/banner/advert to a .XMS file
  233.  
  234.   Usage:
  235.  
  236.     XMASH AddText <Filename>[.xms] Text|Banner <TextFilename>
  237.  
  238.   Simple Example:
  239.  
  240.     XMASH AddText UpLoad:NewDemo.XMS Text BBS:BBSAdvert
  241.  
  242.   Parameters:
  243.  
  244.     All other parameters as per compressing a disk
  245.  
  246. How to add a file description to a .XMS file
  247.  
  248.   Usage:
  249.  
  250.     XMASH AddDesc|Describe <Filename>[.xms]
  251.           DT|DescriptionText <DesciptonFilename>
  252.  
  253.   Simple Example:
  254.  
  255.     XMASH Describe UpLoad:NewDemo.XMS DT FileDescs:NewDemo.DIZ
  256.  
  257.   Parameters:
  258.  
  259.     All parameters as per compressing a disk
  260.  
  261. How to extract a file description from a .XMS file
  262.  
  263.   Usage:
  264.  
  265.     XMASH Extract <Filename>[.xms]
  266.           DT|DescriptionText <DesciptonFilename> [First]
  267.  
  268.   Simple Example:
  269.  
  270.     XMASH Extract UpLoad:NewDemo.XMS DT FileDescs:NewDemo.DIZ
  271.  
  272.   Parameters:
  273.  
  274.     Extract <filename>[.xms]
  275.  
  276.           This parameter tells XMash to extract any file descriptions in the
  277.           XMS file to the file <DescriptionFilename>
  278.  
  279.     First
  280.  
  281.           This parameter tells Xmash to Keep the first file description it
  282.           finds and exit.   Normally Xmash will search the whole .XMS file
  283.           extracting all the descriptions it finds to the
  284.           <DescriptionFilename> file overwriting it every time it comes
  285.           accross another description.  It does this because you may append
  286.           new file descriptions to the end of a .XMS file.
  287.  
  288.     All parameters as per compressing a disk
  289.  
  290.  
  291. How to test a .XMS file
  292.  
  293.   Usage:
  294.  
  295.     XMASH test <Filename>[.xms]
  296.  
  297.   Simple Example:
  298.  
  299.     XMASH test BBS:Playpen/Newfile.TXT
  300.  
  301.   Parameters:
  302.  
  303.     None
  304.  
  305.  
  306.  
  307. Notes
  308.  
  309.   XMASH searches for compressors when you run it so that if it has
  310.   a problem crunching anything it'll keep trying a different compressor
  311.   until it crunches the data correctly!
  312.  
  313.  
  314. Sysops Notes
  315.  
  316. If you are using /X then....
  317.  
  318. Add the following tooltypes to your bbs:doors/fileid/File_ID.info
  319.  
  320. XMS_EX=c:XMSExtract %WFILE_ID.DIZ %P
  321. XMS_AD=c:XMSDescribe %WFILE_ID.DIZ %P
  322.  
  323. this will allow extracting and adding of file_id.diz files to xmash files...
  324.  
  325. Also copy the supplied file in the FCheck directory to your BBS:FCheck directory
  326. to allow checking of XMASH files..
  327.